com.inscoper.nbo.MicroscopeTable¶

Represents the XML element MicroscopeTable. More...

Inherits from com.inscoper.nbo.ManufacturerSpec_Type, com.inscoper.nbo.NBOBaseClass

Public Functions¶

	Name
synchronized void	delete()
	MicroscopeTable()
String	getTypeName() Returns the class type name.
String	getXMLName() Returns the XML element name corresponding to this class.
ENBOType	getNBOType() Returns the NBO Type corresponding to this class.
NBOBaseClassVector	getChildren() Returns a list of all classes derived from this class.
NBOBaseClassVector	getSubElements() Returns a list of all child elements contained in this class.
void	fromJsonFile(String path, boolean validate) Populates this object from a JSON file.
void	fromJsonFile(String path) Populates this object from a JSON file.
void	fromJsonString(String json_string, boolean validate) Populates this object from a JSON string.
void	fromJsonString(String json_string) Populates this object from a JSON string.
void	fromXmlFile(String path, boolean validate) Populates this object from a XML file.
void	fromXmlFile(String path) Populates this object from a XML file.
void	fromXmlString(String xml_string, boolean validate) Populates this object from a XML string.
void	fromXmlString(String xml_string) Populates this object from a XML string.
void	toXmlFile(String filename, boolean validate) Serializes this object to an XML file.
void	toXmlFile(String filename) Serializes this object to an XML file.
String	toXmlString(boolean validate) Serializes this object to an XML string.
String	toXmlString() Serializes this object to an XML string.
void	setID(LSID_Type value, boolean validate) Sets the value of the ID attribute.
void	setID(LSID_Type value) Sets the value of the ID attribute.
LSID_Type	getID() Returns the value of the ID attribute.
void	resetID() Resets the ID attribute to an unset state.
boolean	hasID() Checks whether the optional ID attribute is present.
void	setName(Denomination_Type value, boolean validate) Sets the value of the Name attribute.
void	setName(Denomination_Type value) Sets the value of the Name attribute.
Denomination_Type	getName() Returns the value of the Name attribute.
void	resetName() Resets the Name attribute to an unset state.
boolean	hasName() Checks whether the optional Name attribute is present.
void	setMultipleMicroscopes(boolean value, boolean validate) Sets the value of the MultipleMicroscopes attribute.
void	setMultipleMicroscopes(boolean value) Sets the value of the MultipleMicroscopes attribute.
boolean	getMultipleMicroscopes() Returns the value of the MultipleMicroscopes attribute.
void	resetMultipleMicroscopes() Resets the MultipleMicroscopes attribute to an unset state.
boolean	hasMultipleMicroscopes() Checks whether the MultipleMicroscopes attribute is present.
void	setType(MicroscopeTableType_Type value, boolean validate) Sets the value of the Type attribute.
void	setType(MicroscopeTableType_Type value) Sets the value of the Type attribute.
MicroscopeTableType_Type	getType() Returns the value of the Type attribute.
void	resetType() Resets the Type attribute to an unset state.
boolean	hasType() Checks whether the optional Type attribute is present.
void	setTableWidth(float value, boolean validate) Sets the value of the TableWidth attribute.
void	setTableWidth(float value) Sets the value of the TableWidth attribute.
float	getTableWidth() Returns the value of the TableWidth attribute.
void	resetTableWidth() Resets the TableWidth attribute to an unset state.
boolean	hasTableWidth() Checks whether the TableWidth attribute is present.
void	setTableWidthUnit(UnitsLength_Type value, boolean validate) Sets the value of the TableWidthUnit attribute.
void	setTableWidthUnit(UnitsLength_Type value) Sets the value of the TableWidthUnit attribute.
UnitsLength_Type	getTableWidthUnit() Returns the value of the TableWidthUnit attribute.
void	resetTableWidthUnit() Resets the TableWidthUnit attribute to an unset state.
boolean	hasTableWidthUnit() Checks whether the optional TableWidthUnit attribute is present.
void	setTableDepth(float value, boolean validate) Sets the value of the TableDepth attribute.
void	setTableDepth(float value) Sets the value of the TableDepth attribute.
float	getTableDepth() Returns the value of the TableDepth attribute.
void	resetTableDepth() Resets the TableDepth attribute to an unset state.
boolean	hasTableDepth() Checks whether the TableDepth attribute is present.
void	setTableDepthUnit(UnitsLength_Type value, boolean validate) Sets the value of the TableDepthUnit attribute.
void	setTableDepthUnit(UnitsLength_Type value) Sets the value of the TableDepthUnit attribute.
UnitsLength_Type	getTableDepthUnit() Returns the value of the TableDepthUnit attribute.
void	resetTableDepthUnit() Resets the TableDepthUnit attribute to an unset state.
boolean	hasTableDepthUnit() Checks whether the optional TableDepthUnit attribute is present.
void	setAnnotationRef(AnnotationRef value, boolean validate) Sets the value of the AnnotationRef element.
void	setAnnotationRef(AnnotationRef value) Sets the value of the AnnotationRef element.
AnnotationRef	getAnnotationRef() Returns the value of the AnnotationRef element.
void	resetAnnotationRef() Resets the AnnotationRef element to an unset state.
boolean	hasAnnotationRef() Checks whether the optional AnnotationRef element is present.
MicroscopeTable	__internal_create(long cPtr, boolean own)
MicroscopeTable	fromBase(NBOBaseClass base) Cast a NBOBaseClass to a CMOS.

Protected Functions¶

	Name
	MicroscopeTable(long cPtr, boolean cMemoryOwn)
void	swigSetCMemOwn(boolean own)
void	finalize()
long	getCPtr(MicroscopeTable obj)

Additional inherited members¶

Public Functions inherited from com.inscoper.nbo.ManufacturerSpec_Type

	Name
	ManufacturerSpec_Type()
void	setManufacturer(String value, boolean validate) Sets the value of the Manufacturer attribute.
void	setManufacturer(String value) Sets the value of the Manufacturer attribute.
String	getManufacturer() Returns the value of the Manufacturer attribute.
void	resetManufacturer() Resets the Manufacturer attribute to an unset state.
boolean	hasManufacturer() Checks whether the Manufacturer attribute is present.
void	setModel(String value, boolean validate) Sets the value of the Model attribute.
void	setModel(String value) Sets the value of the Model attribute.
String	getModel() Returns the value of the Model attribute.
void	resetModel() Resets the Model attribute to an unset state.
boolean	hasModel() Checks whether the Model attribute is present.
void	setCatalogNumber(String value, boolean validate) Sets the value of the CatalogNumber attribute.
void	setCatalogNumber(String value) Sets the value of the CatalogNumber attribute.
String	getCatalogNumber() Returns the value of the CatalogNumber attribute.
void	resetCatalogNumber() Resets the CatalogNumber attribute to an unset state.
boolean	hasCatalogNumber() Checks whether the CatalogNumber attribute is present.
void	setLotNumber(String value, boolean validate) Sets the value of the LotNumber attribute.
void	setLotNumber(String value) Sets the value of the LotNumber attribute.
String	getLotNumber() Returns the value of the LotNumber attribute.
void	resetLotNumber() Resets the LotNumber attribute to an unset state.
boolean	hasLotNumber() Checks whether the LotNumber attribute is present.
void	setMapAnnotation_List(MapAnnotationVector value, boolean validate) Sets the list of MapAnnotation elements.
void	setMapAnnotation_List(MapAnnotationVector value) Sets the list of MapAnnotation elements.
MapAnnotationVector	getMapAnnotation_List() Returns the list of MapAnnotation elements.
void	addToMapAnnotation_List(MapAnnotation value, boolean validate) Adds a new MapAnnotation element to this object.
void	addToMapAnnotation_List(MapAnnotation value) Adds a new MapAnnotation element to this object.
void	clearMapAnnotation_List() Clear the list of MapAnnotation.
void	setSpecsFile(FileAnnotation_Type value, boolean validate) Sets the value of the SpecsFile element.
void	setSpecsFile(FileAnnotation_Type value) Sets the value of the SpecsFile element.
FileAnnotation_Type	getSpecsFile() Returns the value of the SpecsFile element.
void	resetSpecsFile() Resets the SpecsFile element to an unset state.
boolean	hasSpecsFile() Checks whether the optional SpecsFile element is present.
void	setAdditionalVendorInformation_List(AdditionalVendorInformationVector value, boolean validate) Sets the list of AdditionalVendorInformation elements.
void	setAdditionalVendorInformation_List(AdditionalVendorInformationVector value) Sets the list of AdditionalVendorInformation elements.
AdditionalVendorInformationVector	getAdditionalVendorInformation_List() Returns the list of AdditionalVendorInformation elements.
void	addToAdditionalVendorInformation_List(AdditionalVendorInformation value, boolean validate) Adds a new AdditionalVendorInformation element to this object.
void	addToAdditionalVendorInformation_List(AdditionalVendorInformation value) Adds a new AdditionalVendorInformation element to this object.
void	clearAdditionalVendorInformation_List() Clear the list of AdditionalVendorInformation.
StringSet	getManufacturerAllowedValues() Returns the allowed values for this attribut.
StringSet	getModelAllowedValues() Returns the allowed values for this attribut.
StringSet	getCatalogNumberAllowedValues() Returns the allowed values for this attribut.
StringSet	getLotNumberAllowedValues() Returns the allowed values for this attribut.

Protected Functions inherited from com.inscoper.nbo.ManufacturerSpec_Type

	Name
	ManufacturerSpec_Type(long cPtr, boolean cMemoryOwn)

Protected Functions inherited from com.inscoper.nbo.NBOBaseClass

	Name
	NBOBaseClass(long cPtr, boolean cMemoryOwn)

Detailed Description¶

public class com.inscoper.nbo.MicroscopeTable;

Represents the XML element MicroscopeTable.

This element describes the Table used to support this Instrument during Image Acquisition.

Public Functions Documentation¶

function delete¶

public synchronized void delete()

Reimplements: com.inscoper.nbo.ManufacturerSpec_Type.delete

function MicroscopeTable¶

public MicroscopeTable()

function getTypeName¶

public String getTypeName()

Returns the class type name.

Return: The class type name

Reimplements: com.inscoper.nbo.ManufacturerSpec_Type.getTypeName

function getXMLName¶

public String getXMLName()

Returns the XML element name corresponding to this class.

Return: The XML element name

Reimplements: com.inscoper.nbo.ManufacturerSpec_Type.getXMLName

function getNBOType¶

public ENBOType getNBOType()

Returns the NBO Type corresponding to this class.

Return: The NBO Type value

Reimplements: com.inscoper.nbo.ManufacturerSpec_Type.getNBOType

function getChildren¶

public NBOBaseClassVector getChildren()

Returns a list of all classes derived from this class.

Return: The list of derived classes

Reimplements: com.inscoper.nbo.ManufacturerSpec_Type.getChildren

function getSubElements¶

public NBOBaseClassVector getSubElements()

Returns a list of all child elements contained in this class.

Return: The list of child classes

Reimplements: com.inscoper.nbo.ManufacturerSpec_Type.getSubElements

function fromJsonFile¶

public void fromJsonFile(
    String path,
    boolean validate
)

Populates this object from a JSON file.

Parameters:

path The path to the JSON file
validate If true, validates constraints on value. Default is true.

Reimplements: com.inscoper.nbo.ManufacturerSpec_Type.fromJsonFile

function fromJsonFile¶

public void fromJsonFile(
    String path
)

Populates this object from a JSON file.

Parameters:

path The path to the JSON file

Reimplements: com.inscoper.nbo.ManufacturerSpec_Type.fromJsonFile

function fromJsonString¶

public void fromJsonString(
    String json_string,
    boolean validate
)

Populates this object from a JSON string.

Parameters:

json_string The JSON content as a string
validate If true, validates constraints on value. Default is true.

Reimplements: com.inscoper.nbo.ManufacturerSpec_Type.fromJsonString

function fromJsonString¶

public void fromJsonString(
    String json_string
)

Populates this object from a JSON string.

Parameters:

json_string The JSON content as a string

Reimplements: com.inscoper.nbo.ManufacturerSpec_Type.fromJsonString

function fromXmlFile¶

public void fromXmlFile(
    String path,
    boolean validate
)

Populates this object from a XML file.

Parameters:

path The path to the XML file
validate If true, validates constraints on value. Default is true.

Reimplements: com.inscoper.nbo.ManufacturerSpec_Type.fromXmlFile

function fromXmlFile¶

public void fromXmlFile(
    String path
)

Populates this object from a XML file.

Parameters:

path The path to the XML file

Reimplements: com.inscoper.nbo.ManufacturerSpec_Type.fromXmlFile

function fromXmlString¶

public void fromXmlString(
    String xml_string,
    boolean validate
)

Populates this object from a XML string.

Parameters:

xml_string The XML content as a string
validate If true, validates constraints on value. Default is true.

Reimplements: com.inscoper.nbo.ManufacturerSpec_Type.fromXmlString

function fromXmlString¶

public void fromXmlString(
    String xml_string
)

Populates this object from a XML string.

Parameters:

xml_string The XML content as a string

Reimplements: com.inscoper.nbo.ManufacturerSpec_Type.fromXmlString

function toXmlFile¶

public void toXmlFile(
    String filename,
    boolean validate
)

Serializes this object to an XML file.

Parameters:

filename The path to the output XML file
validate If true, validates constraints on value. Default is true.

Reimplements: com.inscoper.nbo.ManufacturerSpec_Type.toXmlFile

function toXmlFile¶

public void toXmlFile(
    String filename
)

Serializes this object to an XML file.

Parameters:

filename The path to the output XML file

Reimplements: com.inscoper.nbo.ManufacturerSpec_Type.toXmlFile

function toXmlString¶

public String toXmlString(
    boolean validate
)

Serializes this object to an XML string.

Parameters:

validate If true, validates constraints on value. Default is true.

Return: A string containing the XML representation of this object

Reimplements: com.inscoper.nbo.ManufacturerSpec_Type.toXmlString

function toXmlString¶

public String toXmlString()

Serializes this object to an XML string.

Return: A string containing the XML representation of this object

Reimplements: com.inscoper.nbo.ManufacturerSpec_Type.toXmlString

function setID¶

public void setID(
    LSID_Type value,
    boolean validate
)

Sets the value of the ID attribute.

Parameters:

value The value to set
validate If true, validates constraints on value. Default is true.

A Unique Identifier for this component.

function setID¶

public void setID(
    LSID_Type value
)

Sets the value of the ID attribute.

Parameters:

value The value to set

A Unique Identifier for this component.

function getID¶

public LSID_Type getID()

Returns the value of the ID attribute.

Return: The value of the attribute

A Unique Identifier for this component.

function resetID¶

public void resetID()

Resets the ID attribute to an unset state.

A Unique Identifier for this component.

function hasID¶

public boolean hasID()

Checks whether the optional ID attribute is present.

Return: true if the optional attribute has been set, false otherwise

A Unique Identifier for this component.

function setName¶

public void setName(
    Denomination_Type value,
    boolean validate
)

Sets the value of the Name attribute.

Parameters:

value The value to set
validate If true, validates constraints on value. Default is true.

A User-defined Name for this component.

function setName¶

public void setName(
    Denomination_Type value
)

Sets the value of the Name attribute.

Parameters:

value The value to set

A User-defined Name for this component.

function getName¶

public Denomination_Type getName()

Returns the value of the Name attribute.

Return: The value of the attribute

A User-defined Name for this component.

function resetName¶

public void resetName()

Resets the Name attribute to an unset state.

A User-defined Name for this component.

function hasName¶

public boolean hasName()

Checks whether the optional Name attribute is present.

Return: true if the optional attribute has been set, false otherwise

A User-defined Name for this component.

function setMultipleMicroscopes¶

public void setMultipleMicroscopes(
    boolean value,
    boolean validate
)

Sets the value of the MultipleMicroscopes attribute.

Parameters:

value The value to set
validate If true, validates constraints on value. Default is true.

This field records whether (True) or not (False) multiple Microscopes share this Microscope Table. This is relevant because multiple Microscopes using the same table might affect stability and vibrations during Image Acquisition.

function setMultipleMicroscopes¶

public void setMultipleMicroscopes(
    boolean value
)

Sets the value of the MultipleMicroscopes attribute.

Parameters:

value The value to set

This field records whether (True) or not (False) multiple Microscopes share this Microscope Table. This is relevant because multiple Microscopes using the same table might affect stability and vibrations during Image Acquisition.

function getMultipleMicroscopes¶

public boolean getMultipleMicroscopes()

Returns the value of the MultipleMicroscopes attribute.

Return: The value of the attribute

This field records whether (True) or not (False) multiple Microscopes share this Microscope Table. This is relevant because multiple Microscopes using the same table might affect stability and vibrations during Image Acquisition.

function resetMultipleMicroscopes¶

public void resetMultipleMicroscopes()

Resets the MultipleMicroscopes attribute to an unset state.

This field records whether (True) or not (False) multiple Microscopes share this Microscope Table. This is relevant because multiple Microscopes using the same table might affect stability and vibrations during Image Acquisition.

function hasMultipleMicroscopes¶

public boolean hasMultipleMicroscopes()

Checks whether the MultipleMicroscopes attribute is present.

Return: true if the attribute has been set, false otherwise

This field records whether (True) or not (False) multiple Microscopes share this Microscope Table. This is relevant because multiple Microscopes using the same table might affect stability and vibrations during Image Acquisition.

function setType¶

public void setType(
    MicroscopeTableType_Type value,
    boolean validate
)

Sets the value of the Type attribute.

Parameters:

value The value to set
validate If true, validates constraints on value. Default is true.

This field describes the type of this Microscope Table.

function setType¶

public void setType(
    MicroscopeTableType_Type value
)

Sets the value of the Type attribute.

Parameters:

value The value to set

This field describes the type of this Microscope Table.

function getType¶

public MicroscopeTableType_Type getType()

Returns the value of the Type attribute.

Return: The value of the attribute

This field describes the type of this Microscope Table.

function resetType¶

public void resetType()

Resets the Type attribute to an unset state.

This field describes the type of this Microscope Table.

function hasType¶

public boolean hasType()

Checks whether the optional Type attribute is present.

Return: true if the optional attribute has been set, false otherwise

This field describes the type of this Microscope Table.

function setTableWidth¶

public void setTableWidth(
    float value,
    boolean validate
)

Sets the value of the TableWidth attribute.

Parameters:

value The value to set
validate If true, validates constraints on value. Default is true.

The Width of this Microscope Table.

function setTableWidth¶

public void setTableWidth(
    float value
)

Sets the value of the TableWidth attribute.

Parameters:

value The value to set

The Width of this Microscope Table.

function getTableWidth¶

public float getTableWidth()

Returns the value of the TableWidth attribute.

Return: The value of the attribute

The Width of this Microscope Table.

function resetTableWidth¶

public void resetTableWidth()

Resets the TableWidth attribute to an unset state.

The Width of this Microscope Table.

function hasTableWidth¶

public boolean hasTableWidth()

Checks whether the TableWidth attribute is present.

Return: true if the attribute has been set, false otherwise

The Width of this Microscope Table.

function setTableWidthUnit¶

public void setTableWidthUnit(
    UnitsLength_Type value,
    boolean validate
)

Sets the value of the TableWidthUnit attribute.

Parameters:

value The value to set
validate If true, validates constraints on value. Default is true.

No description available in the XSD standard.

function setTableWidthUnit¶

public void setTableWidthUnit(
    UnitsLength_Type value
)

Sets the value of the TableWidthUnit attribute.

Parameters:

value The value to set

No description available in the XSD standard.

function getTableWidthUnit¶

public UnitsLength_Type getTableWidthUnit()

Returns the value of the TableWidthUnit attribute.

Return: The value of the attribute

No description available in the XSD standard.

function resetTableWidthUnit¶

public void resetTableWidthUnit()

Resets the TableWidthUnit attribute to an unset state.

No description available in the XSD standard.

function hasTableWidthUnit¶

public boolean hasTableWidthUnit()

Checks whether the optional TableWidthUnit attribute is present.

Return: true if the optional attribute has been set, false otherwise

No description available in the XSD standard.

function setTableDepth¶

public void setTableDepth(
    float value,
    boolean validate
)

Sets the value of the TableDepth attribute.

Parameters:

value The value to set
validate If true, validates constraints on value. Default is true.

The Depth of this Microscope Table.

function setTableDepth¶

public void setTableDepth(
    float value
)

Sets the value of the TableDepth attribute.

Parameters:

value The value to set

The Depth of this Microscope Table.

function getTableDepth¶

public float getTableDepth()

Returns the value of the TableDepth attribute.

Return: The value of the attribute

The Depth of this Microscope Table.

function resetTableDepth¶

public void resetTableDepth()

Resets the TableDepth attribute to an unset state.

The Depth of this Microscope Table.

function hasTableDepth¶

public boolean hasTableDepth()

Checks whether the TableDepth attribute is present.

Return: true if the attribute has been set, false otherwise

The Depth of this Microscope Table.

function setTableDepthUnit¶

public void setTableDepthUnit(
    UnitsLength_Type value,
    boolean validate
)

Sets the value of the TableDepthUnit attribute.

Parameters:

value The value to set
validate If true, validates constraints on value. Default is true.

No description available in the XSD standard.

function setTableDepthUnit¶

public void setTableDepthUnit(
    UnitsLength_Type value
)

Sets the value of the TableDepthUnit attribute.

Parameters:

value The value to set

No description available in the XSD standard.

function getTableDepthUnit¶

public UnitsLength_Type getTableDepthUnit()

Returns the value of the TableDepthUnit attribute.

Return: The value of the attribute

No description available in the XSD standard.

function resetTableDepthUnit¶

public void resetTableDepthUnit()

Resets the TableDepthUnit attribute to an unset state.

No description available in the XSD standard.

function hasTableDepthUnit¶

public boolean hasTableDepthUnit()

Checks whether the optional TableDepthUnit attribute is present.

Return: true if the optional attribute has been set, false otherwise

No description available in the XSD standard.

function setAnnotationRef¶

public void setAnnotationRef(
    AnnotationRef value,
    boolean validate
)

Sets the value of the AnnotationRef element.

Parameters:

value The value to set
validate If true, validates constraints on value. Default is true.

This is a simple multi-line comment or annotation describing this component.

function setAnnotationRef¶

public void setAnnotationRef(
    AnnotationRef value
)

Sets the value of the AnnotationRef element.

Parameters:

value The value to set

This is a simple multi-line comment or annotation describing this component.

function getAnnotationRef¶

public AnnotationRef getAnnotationRef()

Returns the value of the AnnotationRef element.

Return: The value of the element

This is a simple multi-line comment or annotation describing this component.

function resetAnnotationRef¶

public void resetAnnotationRef()

Resets the AnnotationRef element to an unset state.

This is a simple multi-line comment or annotation describing this component.

function hasAnnotationRef¶

public boolean hasAnnotationRef()

Checks whether the optional AnnotationRef element is present.

Return: true if the optional attribute has been set, false otherwise

This is a simple multi-line comment or annotation describing this component.

function __internal_create¶

public static MicroscopeTable __internal_create(
    long cPtr,
    boolean own
)

Reimplements: com.inscoper.nbo.ManufacturerSpec_Type.__internal_create

function fromBase¶

public static MicroscopeTable fromBase(
    NBOBaseClass base
)

Cast a NBOBaseClass to a CMOS.

Parameters:

base The base class to cast

Return: The casted element, or nullptr if the cast fails

Reimplements: com.inscoper.nbo.ManufacturerSpec_Type.fromBase

Protected Functions Documentation¶

function MicroscopeTable¶

protected MicroscopeTable(
    long cPtr,
    boolean cMemoryOwn
)

function swigSetCMemOwn¶

protected void swigSetCMemOwn(
    boolean own
)

Reimplements: com.inscoper.nbo.ManufacturerSpec_Type.swigSetCMemOwn

function finalize¶

protected void finalize()

Reimplements: com.inscoper.nbo.ManufacturerSpec_Type.finalize

function getCPtr¶

protected static long getCPtr(
    MicroscopeTable obj
)

Updated on 2026-06-22 at 17:06:31 +0200